Skip to content

Use robot-reported RTDE field types and improved memory copy performance - #560

Merged
urrsk merged 56 commits into
UniversalRobots:masterfrom
urrsk:rtdetype
Oct 1, 2026
Merged

urrsk merged 56 commits into
UniversalRobots:masterfrom
urrsk:rtdetype

Conversation

@urrsk

@urrsk urrsk commented Aug 28, 2026 •

Copy link
Copy Markdown
Member

Summary

Replace the hardcoded RTDE field-name/type table with types reported by the robot during recipe setup. This allows applications to use additional controller fields without updating the library's field table, provided their protocol types are supported.

Changes

  • Apply negotiated types throughout RTDE packages, parsing and writing; expose stored field types through DataPackage::getDataType() and their protocol names through toString(DataType).
  • Add RTDEClient::createInputDataPackage() for pre-typed input packages and validate outgoing packages against the negotiated recipe. Unset input fields in matching recipes are sent as typed zeros.
  • Preserve allocation-free send/receive paths for preallocated, matching recipes, including applying negotiated output types in place.
  • Harden failed handshakes, reconnect handling and fake-server lifecycle; fix output initialization in TCPServer::writeUnchecked().
  • Add robot-free protocol, type-validation, allocation and reconnect tests, controller-backed recipe checks, and a dedicated unit-coverage CI job.

Compatibility

  • Unknown fields raise RTDEInvalidKeyException during RTDEClient::init(), rather than construction. ignore_unavailable_outputs also filters unknown names.
  • Recipe-only packages begin untyped. Input types established by setData() are checked against the robot when sent; pre-typed input packages reject mismatches immediately.
  • getData() still throws std::bad_variant_access for a present field with the wrong or unset type.
  • std::string is no longer a DataPackage variant alternative, so using it with getData() or setData() is a compile error.
  • Direct parser users must configure negotiated layout/type information. Client reads into null pointers or packages with foreign recipes may allocate; reuse a package built from getOutputRecipe() for the allocation-free path.

See doc/migration_notes.rst for migration details.

Copilot AI balanced review requested due to automatic review settings August 28, 2026 09:49
@codecov

codecov Bot commented Aug 28, 2026 •

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 88.10484% with 59 lines in your changes missing coverage. Please review.
✅ Project coverage is 82.36%. Comparing base (9a15f8d) to head (a808853).
⚠️ Report is 32 commits behind head on master.
✅ All tests successful. No failed tests found.

Files with missing lines Patch % Lines
src/rtde/rtde_client.cpp 79.23% 13 Missing and 14 partials ⚠️
src/rtde/rtde_writer.cpp 77.35% 5 Missing and 7 partials ⚠️
src/rtde/rtde_parser.cpp 83.92% 1 Missing and 8 partials ⚠️
src/rtde/data_package.cpp 95.90% 4 Missing and 3 partials ⚠️
include/ur_client_library/rtde/data_package.h 94.11% 0 Missing and 3 partials ⚠️
include/ur_client_library/rtde/rtde_client.h 66.66% 0 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master     #560      +/-   ##
==========================================
+ Coverage   80.86%   82.36%   +1.50%     
==========================================
  Files         119      121       +2     
  Lines        7231     7667     +436     
  Branches     3220     3540     +320     
==========================================
+ Hits         5847     6315     +468     
+ Misses        993      967      -26     
+ Partials      391      385       -6     
Flag Coverage Δ
check_version_ur10-3.15.8 ?
check_version_ur10e-10.11.0 ?
check_version_ur10e-5.15.2 ?
check_version_ur12e-10.12.1 ?
check_version_ur12e-5.25.1 ?
check_version_ur15-10.12.1 ?
check_version_ur15-5.25.1 ?
check_version_ur16e-10.12.1 ?
check_version_ur16e-5.25.1 ?
check_version_ur18-10.12.1 ?
check_version_ur18-5.25.1 ?
check_version_ur20-10.12.1 ?
check_version_ur20-5.25.1 ?
check_version_ur3-3.14.3 ?
check_version_ur30-10.12.1 ?
check_version_ur30-5.25.1 ?
check_version_ur3e-10.11.0 ?
check_version_ur3e-5.9.4 ?
check_version_ur5-3.15.8 ?
check_version_ur5e-10.11.0 ?
check_version_ur5e-5.12.8 ?
check_version_ur7e-10.11.0 ?
check_version_ur7e-5.22.2 ?
check_version_ur8long-10.12.1 ?
check_version_ur8long-5.25.1 ?
python_scripts 75.90% <ø> (ø)
start_ursim 92.20% <ø> (-0.76%) ⬇️
unit 55.58% <87.55%> (?)
ur20-latest ?
ur5-3.14.3 78.80% <87.85%> (+2.34%) ⬆️
ur5e-10.11.0 73.65% <87.65%> (+2.70%) ⬆️
ur5e-10.12.0 74.78% <87.65%> (?)
ur5e-10.7.0 73.11% <87.65%> (+2.41%) ⬆️
ur5e-5.9.4 78.97% <87.65%> (+2.05%) ⬆️
ur7e-10.13.0 75.36% <87.65%> (+2.80%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Moves RTDE field typing from a static table to robot setup acknowledgements while preserving preallocated data paths.

Changes:

  • Adds negotiated DataType handling across packages, parsers, clients, and writers.
  • Adds fake-server, behavior, and allocation tests.
  • Fixes TCPServer::writeUnchecked() initialization.

Reviewed changes

Copilot reviewed 24 out of 24 changed files in this pull request and generated 9 comments.

Show a summary per file
File Description
tests/test_rtde_writer.cpp Tests negotiated writer types and validation.
tests/test_rtde_parser.cpp Tests typed parser behavior.
tests/test_rtde_data_package.cpp Tests dynamic field typing.
tests/test_rtde_client.cpp Updates invalid-recipe expectations.
tests/test_rtde_client_fake_server.cpp Adds robot-free client tests.
tests/test_rtde_allocations.cpp Adds real-time allocation checks.
tests/test_producer.cpp Supplies negotiated parser types.
tests/test_pipeline.cpp Supplies negotiated pipeline types.
tests/rtde_test_helpers.h Adds test access to internal typing APIs.
tests/resources/generate_rtde_outputs.py Sources fields from the fake server.
tests/fake_rtde_server.cpp Emulates recipe type acknowledgements.
tests/CMakeLists.txt Registers new test executables.
src/rtde/rtde_writer.cpp Validates and merges typed input packages.
src/rtde/rtde_parser.cpp Parses using negotiated output types.
src/rtde/rtde_client.cpp Propagates acknowledged recipe types.
src/rtde/data_package.cpp Implements dynamic RTDE typing.
src/comm/tcp_server.cpp Initializes the write counter.
include/ur_client_library/rtde/rtde_writer.h Declares writer type setup.
include/ur_client_library/rtde/rtde_parser.h Declares parser type setup.
include/ur_client_library/rtde/data_package.h Adds DataType and untyped storage.
examples/rtde_client.cpp Removes obsolete string-allocation guidance.
doc/migration_notes.rst Documents behavioral changes.
doc/examples/rtde_client.rst Updates real-time usage guidance.
doc/architecture/rtde_client.rst Documents negotiated typing architecture.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread src/rtde/rtde_parser.cpp Outdated
Comment thread include/ur_client_library/rtde/data_package.h Outdated
Comment thread include/ur_client_library/rtde/rtde_parser.h Outdated
Comment thread include/ur_client_library/rtde/rtde_writer.h Outdated
Comment thread include/ur_client_library/rtde/data_package.h
Comment thread include/ur_client_library/rtde/data_package.h Outdated
Comment thread tests/test_rtde_client_fake_server.cpp Outdated
Comment thread tests/test_rtde_client.cpp
Comment thread tests/test_rtde_data_package.cpp Outdated
Copilot AI review requested due to automatic review settings August 28, 2026 10:17
@urrsk
urrsk marked this pull request as draft August 28, 2026 10:19

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 24 out of 24 changed files in this pull request and generated 2 comments.

Suppressed comments (1)

include/ur_client_library/rtde/data_package.h:124

  • std::string is not one of the RTDE protocol types, but retaining it here lets setData() change an untyped field from monostate to std::string. Such a package then passes isTyped() and serializePackage() emits a malformed variable-length payload, while getDataType() reports no type. Restrict untyped fields to the alternatives represented by DataType.
  using _rtde_type_variant = std::variant<std::monostate, bool, uint8_t, uint32_t, uint64_t, int32_t, double,
                                          vector3d_t, vector6d_t, vector6int32_t, vector6uint32_t, std::string>;

Comment thread src/rtde/rtde_client.cpp Outdated
Comment thread src/rtde/rtde_writer.cpp Outdated
@urrsk
urrsk requested a balanced review from Copilot August 28, 2026 12:15

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 27 out of 27 changed files in this pull request and generated 2 comments.

Suppressed comments (3)

Previously missed (1) — in code that hasn't changed since the last review.

tests/test_rtde_allocations.cpp:52

  • This thread-local design excludes not only the fake server but also the client's background-reader and writer threads. Therefore background_receive_does_not_allocate does not observe the thread that parses received packages, and sending_input_data_does_not_allocate does not observe the thread that serializes and writes them; both tests can pass with allocations in the paths their names claim to cover. Instrument all client-owned threads while excluding only the server thread.
// Counting is per-thread: the fake server and, in the background-read case, the client's read
// thread run in the same process, and their allocations are none of this test's business.
thread_local std::size_t g_allocation_count = 0;
thread_local bool g_count_allocations = false;

src/rtde/rtde_parser.cpp:161

  • A caller can make a preallocated package “typed” with setData() before the first blocking receive, so this check does not prove that its types came from the robot. For example, a timestamp-only package set as uint64_t skips initEmpty(recipe_types_) and parses the robot's DOUBLE bytes as an integer while reporting success. Validate both the recipe and every existing field type against recipe_/recipe_types_, retyping or replacing packages that do not match.
      if (!data_package->isTyped())
      {
        // A package built from a recipe alone doesn't know its field types yet. Applying the ones
        // the robot reported doesn't allocate, so this happens right here rather than by handing
        // the caller a replacement package.

tests/test_rtde_data_package.cpp:460

  • This test does not measure allocations, so an allocation introduced inside initEmpty(types) would still pass despite the test name and the PR's real-time guarantee. Surround this call with the allocation counter (or move this case into the allocation-test binary) and assert that its count remains zero.
  package.initEmpty({ "DOUBLE", "VECTOR6D" });

Comment thread include/ur_client_library/rtde/data_package.h Outdated
Comment thread tests/fake_rtde_server.cpp
@urrsk
urrsk requested a balanced review from Copilot August 28, 2026 13:30

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 27 out of 27 changed files in this pull request and generated no new comments.

Suppressed comments (3)

Previously missed (1) — in code that hasn't changed since the last review.

tests/test_rtde_allocations.cpp:277

  • The counter is thread-local, while sendPackage() only queues data and RTDEWriter::run() performs serialization and socket writing on its own thread. Consequently this measured block cannot see allocations in the actual asynchronous send path, so sending_input_data_does_not_allocate can pass despite a send-thread regression. Add writer-thread instrumentation or a same-thread serialization allocation test.
  {
    AllocationCounter counter;
    for (int i = 0; i < g_MEASURED_CYCLES; ++i)
    {
      all_sent &= input_pkg.setData("speed_slider_fraction", 0.5);
      all_sent &= client_->getWriter().sendPackage(input_pkg);
    }

src/rtde/rtde_parser.cpp:157

  • isTyped() also becomes true when the caller has populated every field with setData(), so it does not prove these are the negotiated types. A preallocated one-field timestamp package set as uint64_t, for example, skips initEmpty(recipe_types_) and parses the robot's DOUBLE bytes as UINT64. This path also never verifies field names, so an untyped same-length package with a different recipe is typed by position. Validate the recipe and always reapply the acknowledged types before parsing; replace the package only when its recipe differs.
      DataPackage* data_package = dynamic_cast<DataPackage*>(result.get());
      data_package->setProtocolVersion(protocol_version_);
      if (!data_package->isTyped())

tests/test_rtde_data_package.cpp:460

  • This test never observes allocations: it only verifies that the package remains usable. The counters in test_rtde_allocations.cpp start after RTDEClient::init() and warmup, so an allocation added to initEmpty(types) would pass the suite even though no-allocation in-place typing is a central guarantee. Measure this call while allocation counting is active.
TEST(rtde_data_package, applying_types_does_not_reallocate)
{
  std::vector<std::string> recipe{ "timestamp", "actual_q" };
  test::TestableDataPackage package(recipe);

  double timestamp = 0.0;
  ASSERT_FALSE(package.getData("timestamp", timestamp));

  package.initEmpty({ "DOUBLE", "VECTOR6D" });

@urrsk
urrsk requested a balanced review from Copilot August 31, 2026 07:28

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 27 out of 27 changed files in this pull request and generated no new comments.

Suppressed comments (2)

Previously missed (2) — in code that hasn't changed since the last review.

tests/test_rtde_allocations.cpp:184

  • This guard can pass while the allocation tests miss the allocations they are intended to detect. As the comment above notes, some libstdc++/musl std::allocator implementations call malloc directly; invoking ::operator new here proves only that this replacement works, while vector/string growth in the measured RTDE paths can bypass it and leave the count at zero. Validate the counter with a representative standard-container allocation and either intercept that platform's allocation path or fail/skip when it cannot be observed.
// Guards the tests below: if the counter stopped seeing allocations, they would pass vacuously.
// Call operator new directly rather than writing `new int`: a new-expression may be omitted even
// when the pointer escapes, which is what Alpine's gcc 15 does at -O2. Allocate with operator new
// rather than a container: on some libstdc++ / musl builds std::allocator uses malloc and would
// never hit the replaced operator new that the RTDE tests count.
TEST(AllocationCounterTest, counts_allocations)
{
  std::size_t allocations = 0;
  {
    AllocationCounter counter;
    g_allocation_sink = ::operator new(sizeof(int));

src/rtde/data_package.cpp:212

  • getDataType() does not necessarily report a robot-acknowledged type as the new API promises. On an application-created input package, setData() changes the variant from monostate to the caller's type, so this function then returns that inferred type—even when RTDEWriter::sendPackage() later rejects it because the robot reported a different type. Consumers therefore cannot tell whether this result is authoritative. Track the acknowledged type separately from the value/inferred type, or explicitly expose this as the stored value type and provide the robot-reported type through the client/writer API.
std::optional<rtde_interface::DataType> rtde_interface::DataPackage::getDataType(const std::string_view name) const
{
  const auto it =
      std::find_if(data_.begin(), data_.end(), [&name](const std::pair<std::string, _rtde_type_variant>& element) {
        return element.first == name;
      });
  if (it == data_.end())
  {
    return std::nullopt;
  }
  return typeOf(it->second);

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

Exception safety, real-time allocation guarantees, and direct protocol-v2 parsing compatibility remain unresolved.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Review details
  • Files reviewed: 32/32 changed files
  • Comments generated: 3
  • Review effort level: Balanced

Comment thread src/rtde/data_package.cpp
Comment thread src/rtde/data_package.cpp
Comment thread src/rtde/data_package.cpp Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The new type-reporting contract is inconsistent with caller-established types, and reconnect tests contain synchronization and coverage defects.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Review details

Suppressed comments (2)

Previously missed (2) — in code that hasn't changed since the last review.

examples/rtde_writer.cpp:93

  • Correct the typo in this user-facing example comment: “may” should be “many.”
    tests/test_rtde_client_reconnect.cpp:320
  • These two point-in-time state checks do not establish that reconnecting stopped. During each retry the client repeatedly returns to UNINITIALIZED, so an implementation that retries forever can satisfy both assertions. Wait for the expected request count and then verify requestedProtocolVersions() remains unchanged (or expose a completion signal) to cover exhaustion rather than an incidental state between attempts.
  • Files reviewed: 32/32 changed files
  • Comments generated: 3
  • Review effort level: Balanced

Comment thread tests/test_rtde_client_reconnect.cpp
Comment thread src/rtde/data_package.cpp
Comment thread src/rtde/rtde_writer.cpp Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

Public setup mutators can race with serialization, and additional undefined-behavior and test-lifetime issues remain.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Review details
  • Files reviewed: 32/32 changed files
  • Comments generated: 4
  • Review effort level: Balanced

Comment thread src/rtde/data_package.cpp
Comment thread src/rtde/rtde_writer.cpp
Comment thread include/ur_client_library/rtde/data_package.h
Comment thread tests/test_rtde_client_reconnect.cpp Outdated
…plate

The deprecated overload read into preallocated_data_pkg_ and then copied it without a
lock, while reconnect() retypes that package holding only reconnect_mutex_. Both the
read and the copy could race with a reconnect and return a partially retyped package.

It now copies the latest background buffer under read_mutex_ into a package it owns
and reads into that instead, so it never touches the template.
Copilot AI review requested due to automatic review settings September 29, 2026 12:06

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🔵 Needs a closer look

Error exits in the new round-trip example can leave its infinite robot program running.

Review effort: Balanced
Findings: None

Resolved since last review (1)
Previously missed (1)

In code that hasn't changed since last review

Medium severity Ensure failures stop the running robot program before returning

examples/​rtde_roundtrip.cpp:155

Any failure inside the loop returns before the cleanup at the end of main, so the uploaded infinite rtde_register_mirror program remains running on the robot (the same bypass occurs at the other two return 1 sites). Route failures through common cleanup or add a scope guard that always calls commandStop() once the script has been launched.

Co-authored-by: Felix Exner <feex@universal-robots.com>
Copilot AI review requested due to automatic review settings September 29, 2026 12:34

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟡 Changes recommended

Writer initialization can permit helper calls to report success while untyped packages serialize to zero bytes.

Review effort: Balanced
Findings: 1 High severity

Open (1)

Comment thread src/rtde/rtde_writer.cpp
Copilot AI review requested due to automatic review settings September 29, 2026 13:03

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟡 Changes recommended

A stopped writer can report successful submission for an update that will never be transmitted.

Review effort: Balanced
Findings: 1 High severity · 1 Medium severity

Open (2)
Previously missed (1)

In code that hasn't changed since last review

Medium severity Reject submissions when the writer thread is stopped

src/​rtde/​rtde_writer.cpp:188

stop() leaves these buffers typed, so this path still returns true while no writer thread is running. That is especially misleading during reconnect: the accepted update is never sent, and the next init() clears new_data_available_. Reject stopped-writer submissions before copying the package.

Comment thread examples/rtde_roundtrip.cpp Outdated
…ic_t in round-trip example

- RTDEWriter::init() throws if setRecipeTypes() has not typed the input buffers.
- sendPackage() and the send* helpers return false while the writer is not running
  instead of silently staging data that would be sent after the next init().
- rtde_roundtrip example uses volatile std::sig_atomic_t for the SIGINT flag and
  drops the g_ prefix.
Copilot AI review requested due to automatic review settings September 29, 2026 13:48

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟡 Changes recommended

Writer initialization and reconnect state can accept or lose concurrent submissions before communication is ready.

Review effort: Balanced
Findings: 1 High severity

Open (1)
Resolved since last review (2)

Comment thread src/rtde/rtde_writer.cpp Outdated
Copilot AI review requested due to automatic review settings September 29, 2026 14:00
Sends could observe running_ before new_data_available_ was cleared and the
writer thread existed, so an accepted update could lose its notification.
Reset the flag and create the thread while holding the mutex, and roll
running_ back if thread creation throws.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🔵 Needs a closer look

Writer thread creation failure can leave the writer running without a worker, causing accepted data to never transmit.

Review effort: Balanced
Findings: 1 High severity

Open (1)

Copilot AI review requested due to automatic review settings September 29, 2026 14:05

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🔵 Needs a closer look

It combines public API, wire-protocol, memory-layout, concurrency, reconnect, and real-time performance changes that warrant final human validation.

Review effort: Balanced
Findings: None

Resolved since last review (1)

@urrsk
urrsk requested a review from urfeex September 30, 2026 06:53
Copilot AI balanced review requested due to automatic review settings October 1, 2026 09:10

@urfeex urfeex left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is looking good now. I verified that parse times aren't negatively affected by the changes made here and I ran some manual tests additionally to reviewing.

@mergify

mergify Bot commented Oct 1, 2026 •

Copy link
Copy Markdown
Contributor

This pull request does not currently match the merge queue conditions, so it cannot be queued from here. The box comes back if it matches again.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟡 Changes recommended

The documentation scraper can still silently select the input table despite its new layout validation.

Review effort: Balanced
Findings: 1 High severity

Open (1)

Comment thread tests/resources/generate_rtde_outputs.py
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants